GET StatusTypes?assetTypeId={assetTypeId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves status types for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetTypeId |
Id of the asset type |
globally unique identifier |
None. |
take |
Number of status types to retrieve. Default is all status types |
integer |
None. |
skip |
Number of status types to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the status types before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of status types.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of StatusType |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "StatusTypeId": "bd6c00af-0227-4447-a5a8-cb992c269da2", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "606d4bf6-19cb-4686-ac35-e42ecf134573", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ace69e74-cdb9-4591-bd1d-0b35deb05a13", "CreateDate": "2024-04-28T13:01:51.4523318-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T13:01:51.4523318-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "ed2a733e-5108-4238-8d03-cb475a8f80de", "CreateDate": "2024-04-28T13:01:51.4523318-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T13:01:51.4523318-07:00", "LastModifiedUser": "sample string 7" }, { "StatusTypeId": "bd6c00af-0227-4447-a5a8-cb992c269da2", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "606d4bf6-19cb-4686-ac35-e42ecf134573", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ace69e74-cdb9-4591-bd1d-0b35deb05a13", "CreateDate": "2024-04-28T13:01:51.4523318-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T13:01:51.4523318-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "ed2a733e-5108-4238-8d03-cb475a8f80de", "CreateDate": "2024-04-28T13:01:51.4523318-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T13:01:51.4523318-07:00", "LastModifiedUser": "sample string 7" } ], "Total": 1, "Message": "sample string 1" }